Alphabetical List of Methods

This topic provides an alphabetical listing of the Methods available for use in Scripts within your Digitise apps. To view the Methods listed by categories, see List of Methods by Category.

Click on a Method in the list below to display a description of that Method. Within the Method descriptions, the following conventions are used:

[...] = optional items which can be omitted when calling the Method.

<...> = the type of data which should be substituted for the bracketed item when calling the Method, e.g. <filename> would indicate that the item should be replaced with a string or variable containing an appropriate file name.

In both cases the brackets are purely for information purposes in the descriptions and should not be included when calling the Method within a Script.

Method names are not case-sensitive.

A - C

Abs Obtain the absolute value of a number.

AddSystemNotification Display Alerts and Reminders.

Atn Obtain the arctangent of an angle.

CancelTransaction Cancel synchronising data.

Chr Convert a decimal value to a character.

ClearControl Clears the contents of a control or all controls.

ClearDataSourceParams Clears a configurable Data Source connection string value and reverts to using the original value.

CreateHash Create a hash value from a specified string.

CreateRecord Create a new blank record and make it the current record.

Cos Obtain the cosine of an angle.

D - F

DateAdd Add a time interval to a date string.

DateDiff Calculate the time interval between two date strings.

DatePart Obtain a specified part of a date string.

Day Obtain the day of the month value from a date string, in numeric format.

DeleteFile Delete a file on the mobile device.

DeleteFolder Delete a Folder on the device.

DeleteRecord Delete the current record in a local database.

DialTelephone Dial a telephone number.

DropDataSource Delete Data Source table(s) from the local database on the mobile device.

Exec Execute a command.

ExitApplication Close the current Digitise app.

ExitClient Close all running Digitise apps and then close down the Digitise Apps Client.

Exp Obtain e raised to a specified power.

FindRecord Search a Data Source for a particular record.

Fix Obtain the integer part of a number.

GetAccessToken Obtain the OAuth Access Token for the currently logged in user.

GetApplicationName Obtain the name of the current Digitise app.

GetApplicationOption Obtain the value of an application option set using SetApplicationOption.

GetBatteryLevel Check the current battery level.

GetColumnSize Obtain the size of the data in a binary column for the current record or all records.

GetControlEnabled Check whether a control is currently enabled or disabled.

GetControlValue Obtain the current value of a control.

GetCurrentForm Obtain the name of the current form.

GetCurrentNetworkType Query the type of network currently in use.

GetCurrentRecordIndex Obtain the index of the current record.

GetCurrentRecordValue Obtain the value of a specified field within the current record.

GetCurrentServer Obtain the address details of the machine running the App Server you are connected to.

GetDataSourceParam Check the value of a configurable element within a specified Data Source's connection string.

GetDeviceCapabilities Check whether device has a Camera and GPS support.

GetDeviceId Obtain the device's ID.

GetDeviceName Obtain the device's name.

GetDeviceType Query the type of device the Digitise app is running on.

GetGPSState Check the current state of the GPS port and whether a valid Fix is available.

GetGPSValue Take GPS reading.

GetLastDataError Obtain information about the last data error which occurred.

GetLastError Obtain information about the last error which occurred.

GetLastErrorLine Obtain Script line on which the last error occurred.

GetLastErrorType Obtain category of error for the last error which occurred.

GetListItems Obtain current contents of a Combo Box, List Box or ListView Control.

GetModifiedRecords Find the number of records that have been modified in a Data Source.

GetNumRecords Find the number of records contained in a Data Source.

GetNumRecordsWhere Find the number of records in a Data Source which match a specified search string.

GetNumSyncErrors Used to query whether there are any error messages after a call to the Synchronise Method.

GetPreviousForm Obtain the name of the previous form.

GetPushNotificationPayload Obtain the data contained in the value field associated with the specified key from the JSON payload contained in a push notification.

GetPushToken Obtain the current push token value.

GetRecordValue Obtain the value of a field within a specified record.

GetSelectedIndex Determine the currently selected item in a Combo Box, List Box or ListView Control.

GetSelectedText Obtain the value of the currently selected item in a Combo Box, List Box or ListView Control.

GetStartupParameter Obtain the parameter string passed to a Digitise app launched by another Digitise app.

GetSyncErrorDataSource Obtain the Data Source to which an error relates after a call to Synchronise.

GetSyncErrorDescription Obtain the description of an error after a call to Synchronise.

GetSyncErrorRecorddIndex Obtain the record index to which an error relates after a call to Synchronise.

GetSystemInfo Obtain version information or screen size and orientation.

GetTelephoneNumber Obtain telephone number from SIM card.

GetTransactionProgress Obtain the current percentage completed of an asynchronous data transfer.

GetTransactionState Obtain the current status of an asynchronous data transaction.

GetUser Find the currently logged-in user.

GetXMLValue Read values extracted from an XML string by the ReadXMLValues Method.

GPSStart Open a COM Port and start reading GPS data.

GPSStop Close a GPS COM Port and stop reading GPS data.

H-K

Hour Obtain the hour value from a date\time string.

Instr Check for the first occurrence of one string within another starting at beginning of string.

InStrRev Check for the first occurrence of one string within another starting at end of string.

IsAlpha Check whether a string contains only alphabetic characters.

IsDate Check whether a string contains a date.

IsDigit Check whether a string contains only numeric characters.

IsNetworkAvailable Check to see whether the network is available.

IsNull Checks whether a string, variable or expression is equal to NULL.

IsNumeric Checks whether a string contains a decimal numeric value.

IsRecordModified Check whether a particular record has been modified.

IsRetrySyncAvailable Check whether the Digitise Apps Client received a response from the App Server to the last call to Synchronise or SyncDataSource.

IsServerAvailable Check to see whether an App Server is available.

IsDataSourceLocked Check to see whether a local table is locked and hence cannot be written to.

IsWhitespace Check whether a string contains only whitespace characters.

L-M

LaunchApplication Run a Digitise app from within the currently running Digitise app.

LCase Convert a string to lower-case.

Left Return part of a string starting from the beginning.

Len Count the number of characters in a string.

LoadDataBase Download data from a Target data source with option to assemble data into database on App Server before downloading to mobile device.

LoadDataSource Download data from a Target data source and, if Target data source is a Web Service, send data to the Web Service.

Log Obtain the natural logarithm of a number.

LTrim Remove whitespace characters from the left-hand side of a string.

Mid Return part of a string starting from a specified position.

Minute Obtain the minute value from a date\time string.

Month Obtain the minute value from a date\time string, in numeric format.

MonthName Return the name of a month from its numerical equivalent.

MsgBox Display a message box.

N-R

Now Obtain the current system date and time.

PlaySound Play a wav file.

Pow Raise one number to the power of another.

ReadColumnFromFile Read a file and write contents to a data record column.

ReadXMLValues Extract elements from an XML string stored in a Data Source.

RefreshControls Update input value(s) in one or all controls from the current record and send data to a Web Service.

RegEx Allows you to compare a string against a 'regular expression'.

RegisterForPush Attempt to register an app with the appropriate push notification service for the type of Device.

RemoveSystemNotification Cancel a previously configured alert or reminder.

Replace Replace all or part of a string with another string.

RetrySync Requests the App Server to send its response to the last Synchronise or SyncDataSource call to the Digitise Apps Client.

Right Return part of a string starting from the right-hand end.

Rnd Randomly generate a number.

Round Round a number to a specified number of decimal places.

RTrim Remove whitespace characters from the right-hand side of a string.

ScaleDataSourceImage Create a scaled version of an image.

ScanBarCode Scan a Bar Code.

Second Obtain the second value from a date\time string.

SelectFirstRecord Make the first record the current record.

SelectLastRecord Make the last record the current record.

SelectLocal Copy records from one local database table to another.

SelectNextRecord Make the next record the current record.

SelectPriorRecord Make the previous record the current record.

SelectRecord Make a record the current record.

SendEmail Send an e-mail.

SendSMS Send a text message.

SetApplicationOption Specify various settings which affect how the camera and progress bar operate.

SetControlBackColour Set a control's background colour.

SetControlEnabled Enable or disable a control.

SetControlFocus Move the Focus to a specified control.

SetControlImage Set the image file name for a Picture & Video Control.

SetControlTextColour Set the colour of text for a control.

SetControlValue Set the value of a control to a specified string value.

SetControlVisible Hide or show a control.

SetCurrentRecordValue Enter a value into a field within the current record.

SetDataErrorOff Turn data error reporting off.

SetDataErrorOn Turn data error reporting on.

SetDataSourceParam Modify a specified Data Source's connection string.

SetFormBackColour Set the current form's background colour.

SetFormTitle Set the current form's title.

SetGlobalTimerInterval Enable/disable the Global Timer and configure time interval.

SetNextForm Set the next form to display when the current Script exits.

SetRecordValue Enter a value into a field within a specified record.

SetSelectedIndex Select an item within a List Box, Combo Box or ListView Control based on its position within the list.

SetSelectedValue Select an item within a List Box, Combo Box or ListView Control based on the item's content.

SetSelectString Specify record selection for use in other Methods.

SetTimerInterval Set the timer interval for a Timer Control.

SetXMLValue Write values into an XML string stored in a Data Source.

Sin Obtain the sine of an angle.

Sqr Obtain the square root of a number.

String Returns a string consisting of a repeating character.

StrReverse Reverse a string.

SyncDataSource Write modified records from local database to a Target data source.

Synchronise Perform background or foreground data transfers to and from the device and a remote Target database.

T-Z

TakePhoto Allow the user to take a photo.

TakeVideo Allow the user to record a video.

Tan Obtain the tangent of an angle.

Trim Remove whitespace characters from both ends of a string.

UCase Convert a string to upper-case.

UpdateCurrentRecord Mark current record as modified and update local database on mobile device.

Vibrate Make the device vibrate.

Weekday Obtain the day of the week value from a date string and return as a number from 1 to 7.

WeekdayName Return the name of a day of the week from its numerical equivalent.

WriteColumnToFile Append a column in the current record to a local file.

WriteFile Append a string to a file.

WriteRecordToFile Append the current record to a file.

Year Obtain the year value from a date\time string.